Variform File Definition form

Administration Settings Database Backed Variforms Database Backed Variforms view Variform File Definition form

Prerequisites

• To be able to override a variform at a specified scope, you need to have the permission to alter the object at that scope.

The Variform File Definition form lets you override any number of existing variforms at your site and enter new variform definitions. You can override a variform at any permissible scope level. This enables you to use different overrides for different scope levels and scopes. This form differs from the Override a Variform Object form (accessible from the Actions menu on the Database Backed Variforms view (on page 1)) in that the Variform File Definition form is recommended for more complex changes to one or more variforms at a time.

When creating a new variform definition, you can:

• Write code from scratch.

• Copy code from an existing form or table, and then modify as needed. To do this:

• In a form, click the Info button in the lower left, and then copy-paste the code from the Form Info form.

• In a table view, click Display Info, and then copy-paste the code from the Table Info form.

• Create code using the XML Stub Generator. To do this:

1. In the Session Factory view, right-click the respective entity and select one of the following:

Generate TABLE XML Stub

Generate FORM XML Stub

Generate Metafield XML Stub

2. Copy-paste the code from the VARIFORM form and modify as needed.

• Extend an existing form or table using the extend attribute.

For more information, see Extending forms and tables (on page 1).

You can only override a variform once.

N4 can dynamically create privileges for completely new variforms so that you can secure them. For this to happen, you must include the following element and attribute in the variform definition: <customization creationType="CUSTOM_NEW"/>

For example:

<table id="CUSTOM_TABLE_SANDBOX_BARS">

<title>Custom Screen</title>

<customization creationType="CUSTOM_NEW"/>

For more information on dynamically generated privileges, see Dynamic privileges (on page 1).

To add or edit a variform file definition:

1. From the Variform Scope Level list, select a scoping level.

2. From the Variform Scope list, select a specific operator, complex, or facility.

3. In the Name field, provide a unique identifier for the configuration.

4. Optionally, provide a Description for the configuration.

5. Optionally, clear the Is Enabled? check box to temporarily disable the overrride if you are still developing the form.

6. Optionally, from the XML Template list, select one of the following XML templates to use for the variform:

• Form: Contains widgets usually displayed in a dialog box; used to enter information about one instance of an entity.

• Table: Displays information about a single entity type in a view composed of rows and columns; also includes a filter toolbar, Actions button, and Display button.

• Gadget: Includes a chart or table that derives information from a data source.

• Panel: A composite view that can include one or more tables, forms, and panels.

• Inspector: Displays information about an entity in a view and provides sub-views (called inspections) for viewing various properties on the entity.

By default, no template is selected.

The Variform XML field displays --loaded-- to indicate a file is linked to the variform.

7. Optionally, if you do not use a template:

1. Click Import File.

2. In the Import XML Configuration dialog box, select the configuration file and click Open.

The Variform XML field displays --loaded-- to indicate a file is linked to the variform.

8. Click Edit Contents to edit or manually enter XML code.

9. Click Save.

To export a variform file definition:

1. Click Export File.

2. In the Export XML Configuration dialog box, specify a name and location for the variform file, including .xml as an extension for the file. N4 does not automatically add the extension to the file name.

3. Click Save.

To remove a variform override, click Clear. N4 deletes the XML file associated with the variform override.

Notes

• If you clear the Is Enabled? check box, the override does not take effect when you reset the variforms (Actions Reset). In this case, the system (default) variform is active at the Global scope.

• You can only override a variform once, regardless of whether an override is enabled or not.

• After you add, edit, or clear a variform override, you must select the Actions Reset option from the Database backed variforms view (on page 1). Select the Only update local node option if you want to test the form locally before propagating the changes to all nodes. Select the Propagate changes to all nodes option if you are ready to distribute the changes to all nodes in the cluster.